home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmCvtXmStringTableToTextProperty.z / XmCvtXmStringTableToTextProperty
Encoding:
Text File  |  2002-10-03  |  8.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooUUUUppppNNNNeeeeIIIIrrrrXXXXXXXXttttmmmmyyyySSSSCCCC((((yyyyvvvv3333ssssttttXXXXttttXXXX))))eeeemmmmmmmmSSSSttttVVVVrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy - A function that converts
  10.           from XmStringTable to an XTextProperty Structure
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           int XmCvtXmStringTableToTextProperty (_d_i_s_p_l_a_y, _s_t_r_i_n_g__t_a_b_l_e, _c_o_u_n_t, _s_t_y_l_e, _t_e_x_t__p_r_o_p__r_e_t_u_r_n)
  15.                   Display *_d_i_s_p_l_a_y;
  16.                   XmStringTable   _s_t_r_i_n_g__t_a_b_l_e;
  17.                   int     _c_o_u_n_t;
  18.                   XmICCEncodingStyle      _s_t_y_l_e;
  19.                   XTextProperty   *_t_e_x_t__p_r_o_p__r_e_t_u_r_n;
  20.           (vvvvooooiiiidddd)
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents Motif 2.1.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy converts the XXXXmmmmSSSSttttrrrriiiinnnnggggs in
  27.           the specified XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee into an _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  28.  
  29.           The function sets the encoding member of _t_e_x_t__p_r_o_p__r_e_t_u_r_n to
  30.           an AAAAttttoooommmm for the specified display naming the encoding
  31.           determined by the specified style, and it converts the first
  32.           _c_o_u_n_t compound strings in the specified XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee to
  33.           this encoding for storage in the _t_e_x_t__p_r_o_p__r_e_t_u_r_n value
  34.           member. Following are the possible encoding styles:
  35.  
  36.           XXXXmmmmSSSSTTTTYYYYLLLLEEEE____CCCCOOOOMMMMPPPPOOOOUUUUNNNNDDDD____SSSSTTTTRRRRIIIINNNNGGGG
  37.                     The encoding is ____MMMMOOOOTTTTIIIIFFFF____CCCCOOOOMMMMPPPPOOOOUUUUNNNNDDDD____SSSSTTTTRRRRIIIINNNNGGGG. The
  38.                     function converts each specified XXXXmmmmSSSSttttrrrriiiinnnngggg to a
  39.                     compound string in Byte Stream format.
  40.  
  41.           XXXXmmmmSSSSTTTTYYYYLLLLEEEE____CCCCOOOOMMMMPPPPOOOOUUUUNNNNDDDD____TTTTEEEEXXXXTTTT
  42.                     The encoding is _C_O_M_P_O_U_N_D__T_E_X_T. The function
  43.                     converts each specified XXXXmmmmSSSSttttrrrriiiinnnngggg to compound text.
  44.  
  45.           XXXXmmmmSSSSTTTTYYYYLLLLEEEE____LLLLOOOOCCCCAAAALLLLEEEE
  46.                     The encoding is the encoding of the current
  47.                     locale. The function converts each specified
  48.                     XXXXmmmmSSSSttttrrrriiiinnnngggg to the encoding of the current locale.
  49.  
  50.           XXXXmmmmSSSSTTTTYYYYLLLLEEEE____SSSSTTTTRRRRIIIINNNNGGGG
  51.                     The encoding is _S_T_R_I_N_G (plain C strings encoded in
  52.                     ISO8859-1), and the function converts each
  53.                     specified XXXXmmmmSSSSttttrrrriiiinnnngggg to _S_T_R_I_N_G.
  54.  
  55.           XXXXmmmmSSSSTTTTYYYYLLLLEEEE____TTTTEEEEXXXXTTTT
  56.                     If all specified XXXXmmmmSSSSttttrrrriiiinnnnggggs are fully convertible
  57.                     to the encoding of the current locale, the
  58.                     encoding is the encoding of the current locale,
  59.                     and the function converts each specified XXXXmmmmSSSSttttrrrriiiinnnngggg
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooUUUUppppNNNNeeeeIIIIrrrrXXXXXXXXttttmmmmyyyySSSSCCCC((((yyyyvvvv3333ssssttttXXXXttttXXXX))))eeeemmmmmmmmSSSSttttVVVVrrrriiiinnnnggggTTTTaaaabbbblllleeeeTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     to the encoding of the current locale. Otherwise,
  75.                     the encoding is _C_O_M_P_O_U_N_D__T_E_X_T, and the function
  76.                     converts each specified compound string to
  77.                     compound text.
  78.  
  79.           XXXXmmmmSSSSTTTTYYYYLLLLEEEE____SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD____IIIICCCCCCCC____TTTTEEEEXXXXTTTT
  80.                     If all specified XXXXmmmmSSSSttttrrrriiiinnnnggggs are fully convertible
  81.                     to _S_T_R_I_N_G, the encoding is _S_T_R_I_N_G, and the
  82.                     function converts each specified XXXXmmmmSSSSttttrrrriiiinnnnggggto
  83.                     _S_T_R_I_N_G. Otherwise, the encoding is _C_O_M_P_O_U_N_D__T_E_X_T,
  84.                     and the function converts each specified XXXXmmmmSSSSttttrrrriiiinnnngggg
  85.                     to compound text.
  86.  
  87.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  88.  
  89.           _s_t_r_i_n_g__t_a_b_l_e
  90.                     Specifies a set of XXXXmmmmSSSSttttrrrriiiinnnnggggs.
  91.  
  92.           _c_o_u_n_t     Specifies the number of XXXXmmmmSSSSttttrrrriiiinnnnggggs to be converted
  93.                     in _s_t_r_i_n_g__t_a_b_l_e.
  94.  
  95.           _s_t_y_l_e     Specifies the manner in which the property is
  96.                     encoded.
  97.  
  98.           _t_e_x_t__p_r_o_p__r_e_t_u_r_n
  99.                     Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  100.  
  101.           To free the storage for the value member of the
  102.           _X_T_e_x_t_P_r_o_p_e_r_t_y, use XXXXttttFFFFrrrreeeeeeee.
  103.  
  104.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  105.           If conversion depends on the locale and the current locale
  106.           is not supported, the function returns XXXXLLLLooooccccaaaalllleeeeNNNNoooottttSSSSuuuuppppppppoooorrrrtttteeeedddd.
  107.           In both of these cases, the function does not set
  108.           _t_e_x_t__p_r_o_p__r_e_t_u_r_n.
  109.  
  110.           To determine whether the function is guaranteed not to
  111.           return XXXXLLLLooooccccaaaalllleeeeNNNNoooottttSSSSuuuuppppppppoooorrrrtttteeeedddd, use XXXXSSSSuuuuppppppppoooorrrrttttssssLLLLooooccccaaaalllleeee.
  112.  
  113.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  114.           XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTooooBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmm(3),
  115.           XXXXmmmmCCCCvvvvttttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyyTTTTooooXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee(3), and XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaabbbblllleeee(3).
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.